Red Tractor API Website - Get Passport Detail

Gets the details of a previously created crops passport document

Path Parameters

Parameter	Description
shortcode	The unique reference number assigned to the passport document

Download Passport GET

Download the details or documentation for an existing crops passport

Parameters

Response Parameters

Parameter	Description
ShortCode String	The unique reference number assigned to the passport
MembershipGUID String	The unique identifier for the crops membership the passport belongs to
SiteGUID String	The unique identifier of the assured site used for the collection address
StoreGUID String	The unique identifier of the assured grain store to be used for the collection pointOptional
BusinessName String	The business name shown on the passport document
CollectionAddress String	The collection address shown on the passport document
CropType String	The crop type shown on the passport documentOptional
Variety String	The crop variety shown on the passport documentOptional
StoreOrBinName String	The store or bin name shown on the passport documentOptional
LoadingDate Date / Time	The loading date shown on the passport documentOptional
HarvestYear String	The harvest year shown on the passport documentOptional
HaulierCompanyName String	The company name of the haulier shown on the passport documentOptional
VehicleRegistration String	The vehicle registration number of the haulier as shown on the passport documentOptional
TrailerNumber String	The trailer number shown on the passport documentOptional
HaulierCollectionTicketNo String	The number of the trailer used to transport the load as shown on the passport document Optional
CertifierName String	The name of the certification body shown for the assurance claim included on the passport document
MembershipNumber String	The Red Tractor membership number for the assurance claim included on the passport document
CheckDate Date / Time	The date the assurance claim included on the passport document was validated
Status String	The validated status of the assurance claim included on the passport document
ExpiryDate Date / Time	The certificate expiry date for the assurance claim included on the passport document
Enterprises String	Comma-delimited list of the certified enterprises shown for the assurance claim included on the passport document
PostHarvestTreatmentOption Enumeration	The post harvest treatment option indicated in section 4 of the passport documentOptional
PostHarvestTreatmentDate Date / Time	The date of post-harvest treatment shown in section 4 of the passport documentOptional
PostHarvestTreatmentProduct String	The product used for post-harvest treatment shown in section 4 of the passport documentOptional
DONRiskAssessmentResult Number	The risk assessment score to be shown in section 5 of the passport documentOptional
DONTestDate Date / Time	The date of test shown in section 5 of the passport document Optional
DONTestResult String	The result shown in section 5 of the passport documentOptional
ZONTestDate Date / Time	The date of test shown in section 5 of the passport documentOptional
ZONTestResult String	The result to be shown in section 5 of the passport document Optional
GrainStoreName String	Name of grain store used as collection pointOptional
GrainStoreLatitude String	Grain store latitude Optional
GrainStoreLongitude String	Grain store longitudeOptional

Enumerations

Post-Harvest Treatment Option (Response)

Value	Description
	None Indicated
A	Option A
B	Option B
C	Option C

XML

Example Request

GET https://api.redtractor.org.uk/v1/passports/{shortcode}.eb HTTP/1.1
Accept: text/xml

Response Schema

<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="CropPassport">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="ShortCode" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The unique reference number assigned to the passport </xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="MembershipGUID" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The unique identifier for the crops membership the passport belongs to</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="SiteGUID" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The unique identifier of the assured site used for the collection address </xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="StoreGUID" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The unique identifier of the assured grain store to be used for the collection point</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="BusinessName" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The business name shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="CollectionAddress" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The collection address shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="CropType" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The crop type shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="Variety" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The crop variety shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="StoreOrBinName" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The store or bin name shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="LoadingDate" minOccurs="0" type="xsd:dateTime">
          <xsd:annotation>
            <xsd:documentation>The loading date shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="HarvestYear" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The harvest year shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="HaulierCompanyName" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The company name of the haulier shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="VehicleRegistration" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The vehicle registration number of the haulier as shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="TrailerNumber" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The trailer number shown on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="HaulierCollectionTicketNo" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The number of the trailer used to transport the load as shown on the passport document </xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="CertifierName" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The name of the certification body shown for the assurance claim included on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="MembershipNumber" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The Red Tractor membership number for the assurance claim included on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="CheckDate" type="xsd:dateTime">
          <xsd:annotation>
            <xsd:documentation>The date the assurance claim included on the passport document was validated</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="Status" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The validated status of the assurance claim included on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="ExpiryDate" type="xsd:dateTime">
          <xsd:annotation>
            <xsd:documentation>The certificate expiry date for the assurance claim included on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="Enterprises" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>Comma-delimited list of the certified enterprises shown for the assurance claim included on the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="PostHarvestTreatmentOption" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>The post harvest treatment option indicated in section 4 of the passport document</xsd:documentation>
          </xsd:annotation>
          <xsd:simpleType>
            <xsd:restriction base="xsd:string">
              <xsd:enumeration value="">
                <xsd:annotation>
                  <xsd:documentation>None Indicated</xsd:documentation>
                </xsd:annotation>
              </xsd:enumeration>
              <xsd:enumeration value="A">
                <xsd:annotation>
                  <xsd:documentation>Option A</xsd:documentation>
                </xsd:annotation>
              </xsd:enumeration>
              <xsd:enumeration value="B">
                <xsd:annotation>
                  <xsd:documentation>Option B</xsd:documentation>
                </xsd:annotation>
              </xsd:enumeration>
              <xsd:enumeration value="C">
                <xsd:annotation>
                  <xsd:documentation>Option C</xsd:documentation>
                </xsd:annotation>
              </xsd:enumeration>
            </xsd:restriction>
          </xsd:simpleType>
        </xsd:element>
        <xsd:element name="PostHarvestTreatmentDate" minOccurs="0" type="xsd:dateTime">
          <xsd:annotation>
            <xsd:documentation>The date of post-harvest treatment shown in section 4 of the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="PostHarvestTreatmentProduct" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The product used for post-harvest treatment shown in section 4 of the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="DONRiskAssessmentResult" minOccurs="0" type="xsd:double">
          <xsd:annotation>
            <xsd:documentation>The risk assessment score to be shown in section 5 of the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="DONTestDate" minOccurs="0" type="xsd:dateTime">
          <xsd:annotation>
            <xsd:documentation>The date of test shown in section 5 of the passport document </xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="DONTestResult" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The result shown in section 5 of the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="ZONTestDate" minOccurs="0" type="xsd:dateTime">
          <xsd:annotation>
            <xsd:documentation>The date of test shown in section 5 of the passport document</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="ZONTestResult" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The result to be shown in section 5 of the passport document </xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="GrainStoreName" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>Name of grain store used as collection point</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="GrainStoreLatitude" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>Grain store latitude
</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="GrainStoreLongitude" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>Grain store longitude</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<CropPassport>
  <ShortCode>xsd:string</ShortCode>
  <MembershipGUID>xsd:string</MembershipGUID>
  <SiteGUID>xsd:string</SiteGUID>
  <StoreGUID>xsd:string</StoreGUID>
  <BusinessName>xsd:string</BusinessName>
  <CollectionAddress>xsd:string</CollectionAddress>
  <CropType>xsd:string</CropType>
  <Variety>xsd:string</Variety>
  <StoreOrBinName>xsd:string</StoreOrBinName>
  <LoadingDate>xsd:dateTime</LoadingDate>
  <HarvestYear>xsd:string</HarvestYear>
  <HaulierCompanyName>xsd:string</HaulierCompanyName>
  <VehicleRegistration>xsd:string</VehicleRegistration>
  <TrailerNumber>xsd:string</TrailerNumber>
  <HaulierCollectionTicketNo>xsd:string</HaulierCollectionTicketNo>
  <CertifierName>xsd:string</CertifierName>
  <MembershipNumber>xsd:string</MembershipNumber>
  <CheckDate>xsd:dateTime</CheckDate>
  <Status>xsd:string</Status>
  <ExpiryDate>xsd:dateTime</ExpiryDate>
  <Enterprises>xsd:string</Enterprises>
  <PostHarvestTreatmentOption>xsd:string</PostHarvestTreatmentOption>
  <PostHarvestTreatmentDate>xsd:dateTime</PostHarvestTreatmentDate>
  <PostHarvestTreatmentProduct>xsd:string</PostHarvestTreatmentProduct>
  <DONRiskAssessmentResult>xsd:double</DONRiskAssessmentResult>
  <DONTestDate>xsd:dateTime</DONTestDate>
  <DONTestResult>xsd:string</DONTestResult>
  <ZONTestDate>xsd:dateTime</ZONTestDate>
  <ZONTestResult>xsd:string</ZONTestResult>
  <GrainStoreName>xsd:string</GrainStoreName>
  <GrainStoreLatitude>xsd:string</GrainStoreLatitude>
  <GrainStoreLongitude>xsd:string</GrainStoreLongitude>
</CropPassport>

Download full schema

JSON

Example Request

GET https://api.redtractor.org.uk/v1/passports/{shortcode}.eb HTTP/1.1
Accept: application/json

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{"ShortCode":String,
  "MembershipGUID":String,
  "SiteGUID":String,
  "StoreGUID":String,
  "BusinessName":String,
  "CollectionAddress":String,
  "CropType":String,
  "Variety":String,
  "StoreOrBinName":String,
  "LoadingDate":String,
  "HarvestYear":String,
  "HaulierCompanyName":String,
  "VehicleRegistration":String,
  "TrailerNumber":String,
  "HaulierCollectionTicketNo":String,
  "CertifierName":String,
  "MembershipNumber":String,
  "CheckDate":String,
  "Status":String,
  "ExpiryDate":String,
  "Enterprises":String,
  "PostHarvestTreatmentOption":String,
  "PostHarvestTreatmentDate":String,
  "PostHarvestTreatmentProduct":String,
  "DONRiskAssessmentResult":Number,
  "DONTestDate":String,
  "DONTestResult":String,
  "ZONTestDate":String,
  "ZONTestResult":String,
  "GrainStoreName":String,
  "GrainStoreLatitude":String,
  "GrainStoreLongitude":String}

PDF

Example Request

GET https://api.redtractor.org.uk/v1/passports/{shortcode}.eb HTTP/1.1
Accept: application/pdf

Example Response

HTTP/1.1 200 OK
Content-Type: application/pdf

...

Status Codes

Status and Error Codes

HTTP Status	Error Code and Description
200	The list of sites and subscriptions is provided in the response
400	OperationError:StatusNotValid

Set the accept header to specify the format in which the passport data is returned. By specifying "application/pdf" as the desired format, the pre-filled document is returned in PDF format ready for final completion and printing.